Create Essentials Customer
This request creates a new customer with a single site location and with the Hosted Essentials license type.
URL
{{baseUrl}}/api/v2/customer
HTTP Method
POST
Request Body
Parameter |
Type |
Description |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shortName |
string |
Short customer name, complying with validation rules for customer name:
|
||||||||||||||||||||||||
fullName |
string |
The customer full name (optional). | ||||||||||||||||||||||||
siteLocation |
list array |
The site location represents a an SBC configuration for a specific customer. This list array includes the following parameters:
|
||||||||||||||||||||||||
sbcId |
integer |
The SBC Id in the SBC List (Known SBCs). For more information, see Managing SBC Devices. |
||||||||||||||||||||||||
sbcOnboardingScript |
integer |
The required value for an SBC Onboarding script. For more information, see SBC Template Scenarios. |
||||||||||||||||||||||||
sbcCleanupScript |
integer |
The required value for an SBC Cleanup script (see SBC Template Scenarios). |
||||||||||||||||||||||||
ovocCustomerType |
string One of the following values:
|
|
||||||||||||||||||||||||
msTenantId |
string |
Microsoft Tenant ID of customer tenant for validation. |
||||||||||||||||||||||||
channelId |
string |
The channel Id of the customer tenant. See Get List of Channels. |
||||||||||||||||||||||||
lcCustomerId |
string |
The customer Id in the Live Platform. When you specify this value the service is created under this entity. This value is currently not retrievable using the REST API. If not specified, both a new customer and service entity are created in Live Platform with the same shortName. |
||||||||||||||||||||||||
Script parameters |
list array |
The following Script parameters can be sent in this request:
|
||||||||||||||||||||||||
CACProfile |
string |
The preconfigured value for Number of CAC sessions" e.g. "10 sessions" (see Get SBC Devices) |
||||||||||||||||||||||||
Proxy Set |
string |
The SBC Proxy Set value e.g. SIP Trunk |
||||||||||||||||||||||||
OnlinePstnGateway |
string |
The Online PSTN Gateway for the SBC device managing calling functionality for the tenant. |
||||||||||||||||||||||||
CarrierUserName |
string |
The digest MD5 Authentication username. The valid value is a string of up to 60 characters. By default, no value is defined. |
||||||||||||||||||||||||
CarrierUserPassword |
string |
The digest MD5 Authentication password. The valid value is a string of up to 50 characters. Note: The password cannot be configured with wide characters. |
||||||||||||||||||||||||
CarrierMainLine |
string |
The AOR username. This appears in REGISTER From/To headers as ContactUser@HostName. |
||||||||||||||||||||||||
CarrierHostName |
string |
The Address of Record (AOR) host name. The host name appears in SIP REGISTER From/To headers as ContactUser@HostName. |
||||||||||||||||||||||||
CustomVar.Variable<VariableSequenceNumber> |
string where <VariableSequenceNumber> is the sequence in database that the variable is defined in the 'Customer variables' column for the script properties (see Customer Variables). For example, when the following IP-PBX variables are defined in the database in the order: IPPBX-ProxyAddress, IPPBX-ProxyAddress-SIPPort, SIP-HostName then Custom variables should be defined as follows:
|
Custom variables can be defined to update specific parameters on the SBC device. These variables must be predefined in the UMP-365 database (see Customer Variables). Also verify that the custom variables notation has been added to the script (see parameter 'sbcOnboardingScript' above) that you are applying to this request. There is no limitation for the number of variables that are added. |
||||||||||||||||||||||||
additionalProp1 |
string |
One of the following values:
|
||||||||||||||||||||||||
additionalProp2 |
string |
One of the following values:
|
||||||||||||||||||||||||
additionalProp3 |
string |
One of the following values:
|
Example Body
{
"shortName": "SaraTest1",
"fullName": "SaraTest1",
"siteLocation": {
"sbcId": 5,
"sbcOnboardingScript": 10007,
"sbcCleanupScript": 10700
},
"ovocCustomerType": "IPGROUP_TYPE",
"msTenantId": "4bf50a33-a383-4d3f-9403-220c898bc1b2",
"scriptParameters": {
"CacProfile": "5 sessions",
"ProxySet": "SIPTrunk",
"OnlinePstnGateway": "BradDRService.sandbox2.audiocodes.be",
"additionalProp1": "Service Provider2 SBC"
}
}
Example Response
{
"id": "b38e5a04-6d32-4be8-95bb-53bf7d6fa95c",
"customerId": "SaraTest1",
"siteLocationIds": [
"2205294f-9111-4e9d-8343-bd24f8e7a90f"
],
"deploymentState": "Deployed",
"errorDetails": null,
"progressDetails": "(Information, MsTenantid is valid);(Information, Customer data created!);(Information, SBC sbc-onboarding done for site SaraTest1.);(Information, CreateSiteInOvoc started.);(Information, Site created in Ovoc)"
}
HTTP Responses
■ | 200 OK |
Parameter |
Type |
Description |
||||||
---|---|---|---|---|---|---|---|---|
id |
string |
Unique customer Id created by this request (customerGuid). |
||||||
customerId |
string |
Customer ShortName |
||||||
siteLocationIds |
integer |
|
||||||
deploymentState |
string |
One of the following values:
|
||||||
errorDetails |
string |
Error information. |
||||||
progressDetails |
string |
Progress details regarding the deployment. See example below. Copy
|
If Live Platform (UMP-365) server is configured as a tenant in server, the sbcId must be the id of the SBC device registered in Live Platform (OVOC) server.